What is produced

In addition to documenting the basic structure of your project, Document! VB will document :

• The Syntax of your Methods, Events and Properties;
• The Parameters of your Methods and Properties, including hyperlinks where the parameter type is one of your projects documented modules;
• Enumerations, down the level of listing the Enumeration members where a Return type or Parameter type is an enumeration defined within your project;
• Return types, again including hyperlinks where the return type is one of you projects documented modules;
• Collections, by identifying internal modules supporting the NewEnum member.

Your existing source code comments

Document! VB will (optionally) intelligently extract your existing source code comments for inclusion into the generated HTML Help file.  Comments can also be explicitly identified where required (such as comments relating to Method or Property parameters).  The format and layout style of the generated HTML can be controlled through the use of standard cascading style sheets, as well as through bespoke HTML Template files, such that your documentation can adopt a precise customised look and feel.

Context sensitive Help

Document! VB can add context sensitive help support to your components and related HTML Help File, such that a user of your components invoking F1 on a method, property or object name or from within the Visual Basic Object Browser will invoke the appropriate topic generated HTML Help File.  This process takes place totally automatically, including the generating of Topic IDs, the generation of MAP and ALIAS sections within the HTML Help Project, and the setting of the VB Projects HelpFile property, all without the need for any manual intervention.  This feature alone can save hours of development time.

Contents Page

A contents tree, with topics grouped into Objects, Collections, Properties, Methods, Events, Enumerations and Libraries is automatically generated.  These files can be generated from a bespoke template format, enabling you to customise and supplement the default contents.

Index

A full index, containing entries for every page created, is included in the generated HTML Help File.  The index file can be generated from a bespoke template format, enabling you to customise and supplement the default contents.

Full Text Search and Favorites

The Full Text Search and Favorites features of HTML Help are exploited and are available in the generated HTML Help File (this feature requires version 1.2 of the Microsoft HTML Help Workshop and compiler).